<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>PlPN::TextOutput - The text output window object</title>
<link rel="stylesheet" href="../PlPN.css" type="text/css" />
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:" />
</head>

<body>


<!-- INDEX BEGIN -->
<div name="index">
<p><a name="__index__"></a></p>

<ul>

	<li><a href="#name">NAME</a></li>
	<li><a href="#synopsis">SYNOPSIS</a></li>
	<li><a href="#description">DESCRIPTION</a></li>
	<li><a href="#methods">METHODS</a></li>
	<li><a href="#copyright_and_licence">COPYRIGHT and LICENCE</a></li>
</ul>

<hr name="index" />
</div>
<!-- INDEX END -->

<p>
</p>
<h1><a name="name">NAME</a></h1>
<p>PlPN::TextOutput - The text output window object</p>
<p>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<pre>
        use PlPN qw(PN);
        
        my $to = PN-&gt;GetGlobalOutputWindow;
        $to-&gt;AddToolOutput($string);
        
        # etc.</pre>
<p>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
<p>Allows manipulation of text output windows from Perl.</p>
<p>Note: Currently only the global output window is available; the extensions
interface does not allow access to the individual output windows.</p>
<p>
</p>
<hr />
<h1><a name="methods">METHODS</a></h1>
<dl>
<dt><strong><a name="addtooloutput" class="item">AddToolOutput($output, $length = length($output))</a></strong></dt>

<dd>
<p>Adds output to the window. You may also explicitly set a length if you only
want part of the string.</p>
</dd>
<dt><strong><a name="settoolbasepath" class="item">SetToolBasePath($path)</a></strong></dt>

<dd>
<p>Sets the base path for matched error messages in the window.</p>
</dd>
<dt><strong><a name="settoolparser" class="item">SetToolParser($parser = undef)</a></strong></dt>

<dd>
<p>Sets the error message parser for the window. If <code>$parser</code> is false, the
built-in parser is used. Otherwise, <code>$parser</code> will be treated as a regular
expression and used to determine error messages in the window.</p>
</dd>
<dt><strong><a name="clearoutput" class="item">ClearOutput()</a></strong></dt>

<dd>
<p>Clears the output window of all text.</p>
</dd>
<dt><strong><a name="showoutput" class="item">ShowOutput()</a></strong></dt>

<dd>
<p>Shows the output window.</p>
</dd>
<dt><strong><a name="hideoutput" class="item">HideOutput()</a></strong></dt>

<dd>
<p>Hides the output window.</p>
</dd>
</dl>
<p>
</p>
<hr />
<h1><a name="copyright_and_licence">COPYRIGHT and LICENCE</a></h1>
<p>Copyright (c) 2012 Sean Healy. All rights reserved.</p>
<p>This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.</p>

</body>

</html>
